home *** CD-ROM | disk | FTP | other *** search
/ Developer CD Series 2000 April: Mac OS SDK / Dev.CD Apr 00 SDK1.toast / Development Kits / Mac OS / Instrumentation SDK / Quick Start next >
Encoding:
Text File  |  1998-06-19  |  2.7 KB  |  72 lines  |  [TEXT/ttxt]
  1.  
  2. This is a brief description of each component of the Instrumentation SDK.
  3.  
  4. Read Me:
  5. Contains details of the current release of the Instrumentation SDK, as well as common questions-and-answers about instrumentation.
  6.  
  7.  
  8. InstrumentationLib
  9.  
  10. Programs call this shared library to generate instrumentation data. It should go into your Extensions folder.
  11.  
  12.  
  13. Instrumentation ƒ
  14.  
  15. Drag this folder to the root of your boot volume. It contains the OneShot Collector, which is used to produce an instrumentation file from data in memory, as well as spoolers that can be used to collect data over time.
  16.  
  17.  
  18. Viewer:
  19.  
  20. The Instrumentation Viewer displays instrumentation data. It uses the InstrumentationBackend shared library to interpret the data files.
  21.  
  22.  
  23. Test Target:
  24.  
  25. This folder contains a small application whose imported routines have been instrumented. You can use it to check that the InstrumentationLib is working on your system. Run the OneShot Collector to get a data file.
  26.  
  27.  
  28. Experimental InterfaceLib:
  29.  
  30. InterfaceLib is the shared library that PowerPC code links against to get access to most MacOS API's. The version in this folder, InterfaceLib.prof, has been instrumented with MrPlus so that calling it will produce trace events.
  31.  
  32. If you place it and ProfileLib in the same folder as your application and run your application, you can look at the trace data to find out what sort of calls you're making to InterfaceLib.
  33.  
  34.  
  35. Interfaces & Libraries:
  36.  
  37. CIncludes:
  38. Instrumentation.h declares the C API to the instrumentation library. InstrumentationMacros.h contains various convenience macros for instrumentation clients.
  39.  
  40. SharedLibraries:
  41. InstrumentationLib is the stub library that PowerPC projects should link against when they are built.
  42.  
  43. 68K Static Libs:
  44. These libraries are front-ends to the InstrumentationLib for 68K clients. InstrumentationLib68K.o is in MPW's Linker format. InstrumentationLib68K is in CodeWarrior format.
  45.  
  46.  
  47. Documentation:
  48.  
  49. Inst. System User's Guide.pdf
  50.  
  51. This manual explains how to install the SDK,  how to use it to collect data, and how to instrument a compiled binary using MrPlus.
  52.  
  53. Inst. Programmer's Guide.pdf
  54.  
  55. This manual describes how to modify your source code to have your program generate instrumentation data.
  56.  
  57. Inst. Viewer User's Guide.pdf
  58.  
  59. This manual describes how to use the Instrumentation Viewer to display and manipulate the instrumentation data that is generated by the SDK.
  60.  
  61.  
  62. Sample Code:
  63.  
  64. The code in this folder demonstrates how to generate instrumentation data. SampleTrace.c creates trace events. SampleGrowthAndMag.c creates simple counters. SampleHistogram.c shows how to generate histograms and split histograms. SampleTally.c demonstrates the use of tallies, which are similar to histograms.
  65.  
  66.  
  67. Packing List:
  68.  
  69. This file.
  70.  
  71.  
  72.